Add README and improve documentation for WebServer basic example #215
Conversation
|
Thank you for your pull request and welcome to our community! To contribute, please sign the Oracle Contributor Agreement (OCA).
To sign the OCA, please create an Oracle account and sign the OCA in Oracle's Contributor Agreement Application. When signing the OCA, please provide your GitHub username. After signing the OCA and getting an OCA approval from Oracle, this PR will be automatically updated. If you are an Oracle employee, please make sure that you are a member of the main Oracle GitHub organization, and your membership in this organization is public. |
oracle-contributor-agreement
bot
added
the
OCA Required
|
Thanks for contributing to Helidon! The |
NA-V10
force-pushed
the
improve-basic-webserver-example
branch
from
83630bc to
761c80d
Compare
romain-grecourt
left a comment
romain-grecourt
left a comment
There was a problem hiding this comment.
- The ASCII file tree needs to be escaped as a mono-spaced text block (three back-ticks).
- There is no heading for the sections (the usual sections are build / run / exercise the application)
- While the Unicode emojis are nice, it's not consistent with the other examples.
|
Thank you for signing the OCA. |
oracle-contributor-agreement
bot
added
OCA Verified
romain-grecourt
left a comment
romain-grecourt
left a comment
There was a problem hiding this comment.
You need to fix all headings.
Make sure to look at the rendered output.
| @@ -0,0 +1,69 @@ | |||
| ##WebServer Basic Example | |||
There was a problem hiding this comment.
You need spaces after the #.
See
3 participants
Summary
This PR adds a clear and beginner-friendly README.md to the examples/webserver/basic example in the Helidon examples repository. This example is usually the first place new users learn Helidon SE WebServer, so providing proper documentation significantly improves onboarding and clarity.
What’s Included
Added README.md explaining:
What the example demonstrates
How the WebServer starts
How routing works
Available endpoints
How to run the example
Tests included in the folder
Project structure
Ensures the example is easier to understand for beginners and new contributors.
Why This PR Is Useful
The basic example had no dedicated README, making it hard for new developers to understand how Helidon SE WebServer works.
This PR improves:
Learnability
Documentation quality
Onboarding experience
Consistency with other Helidon examples
Additional Notes
No production code was modified
Only documentation files were added
Fits Helidon’s style of example documentation